home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / com / othernet / fidonet / sigad103 / sigadd.doc < prev    next >
Text File  |  1994-08-24  |  11KB  |  264 lines
  1.  
  2.                             SIGaddST
  3.  
  4.                     Copyright (c) Paul Civati
  5.  
  6.                           Version 1.03
  7.  
  8.                            Aug 24 1994
  9.  
  10.             Coded with Sozobon/HSC (Heat & Serve C) v1.40
  11.  
  12.       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  13.  
  14. SIGaddST is simply a program for adding signatures to messages that you've
  15. written in QBBS format message bases.  It gets the signatures from text
  16. files, which can be a default text file or an individual one for certain
  17. areas.  In these text files can be control codes to add things like random
  18. taglines, a default tagline file is used or again individual tagline files
  19. for certain areas.
  20.  
  21.  
  22. SIGaddST has been tested with the following mail processors:
  23.  
  24.                                Echomail          Netmail
  25. Mail Processor               Compatibility    Compatibility
  26. -----------------------------------------------------------
  27. ACS 1.31 ....................... Yes ............. No .....
  28. ACS 1.33 ....................... Yes ............. Yes ....
  29. JetMail 0.99beta9 .............. Yes ............. No .....
  30.  
  31.   * Compatibility is determined by how the mail processor handles the
  32.     mailer[7] field of the msgbase, explained later in the docs.
  33.  
  34.  
  35. In the archive you should find the following files:
  36.  
  37.     SIGADD.DOC ....... You're reading it!
  38.     SIGADD.TOS ....... The main executable
  39.     SIGADD.CFG ....... An example of the main configuration file
  40.     SIGADD.LST ....... An example of an areas list file
  41.     GENERAL.SIG ...... My sigfile, the default for the above config
  42.     SMALADDR.SIG ..... Another of my signature files, as in the config
  43.     USENET.SIG ....... Another of my signature files, as in the config
  44.     USENETST.SIG ..... Another of my signature files, as in the config
  45.     TAGLINES.TXT ..... A few example taglines, you should get yer own ;-)
  46.  
  47.  
  48.  
  49. OPERATION:
  50. ==========
  51.  
  52. SIGadd should be run after you've written all your messages, it will then
  53. find these using the name specified in the configuration file and checking
  54. that the mailer[7] field in the msg header is equal to 0 and not marked as
  55. deleted.
  56.  
  57. As SIGadd processes all the messages it will write out a logfile (SIGADD.LOG)
  58. showing what it has done.  To add the signature to each message it first
  59. adds the new message text to the bottom of the .MSG file and creates a new
  60. record for it in the .HDR file, then it marks the original as deleted so
  61. that the mail processing software will delete it when it tidies up the
  62. message base.
  63.  
  64. The following is a summary of the logging types SIGadd outputs to the
  65. SIGADD.LOG log file:
  66.  
  67.     ' ' ... Unimportant
  68.     '*' ... Begin/end
  69.     '+' ... Writing a file
  70.     '-' ... Reading a file
  71.     '#' ... Area process info
  72.     '!' ... Error
  73.     '%' ... Statistical
  74.     '=' ... Appending
  75.     '?' ... Query
  76.  
  77. This list may be used as a referance for disabling certain output, this is
  78. explained in more detail later.
  79.  
  80. Care should be taken not to process the messages you've written more than
  81. once, so once you have run SIGadd you should run your mail export software
  82. afterwards (the mailer[7] field will then be set to something other than
  83. zero when your mailer s/w processes it and SIGadd won't process the message
  84. again).
  85.  
  86.  
  87.  
  88. MAIN CONFIGURATION:
  89. ===================
  90.  
  91. The 'Name' keyword should be your name, so SIGadd finds the message you've
  92. written.  The 'AddText' keyword should be the default signature that is
  93. added to messages.  The 'AreasList' keyword is the file that contains the
  94. list of areas you want to add signatures to.  The 'QuoteFile' keyword is the
  95. default file of one line quotes you want added to your messages where %q is
  96. placed.
  97.  
  98. Each line of the areas list file is as follows:
  99.  
  100. <area>,[<opt alt SIG file>],[<opt alt tagline file>],[<opt alt fromname>]
  101.  
  102. Each area is specified one per line with _no_ extension, then an alernate
  103. signature file can be specified, this must be placed after a comma, then an
  104. alternate tagline file can be added as well, again after another comma, and
  105. lastly another option is again after a comma and is an alternate 'from name'.
  106.  
  107. This 'from name' is used put in the from field of msgs that SIGadd rewrites,
  108. any spaces are specified by underscores and replaced by spaces when the name
  109. is replaced.  For example specifying 'The_Evil_PaulC' in your config will
  110. replace with name in the from field with 'The Evil PaulC'.
  111.  
  112. The alternate files only overide the default file for the area where they
  113. are specified.
  114.  
  115. The tagline file is a list of up to 200 taglines, one per line, which are
  116. randomly added into the signature where specified.  This is specified by
  117. using the correct control code, current codes are:
  118.  
  119.     %q ... replace with random tagline
  120.     %d ... date (at time of SIGadd processing)
  121.     %t ... time (at time of SIGadd processing)
  122.     %n ... name of the person message is addressed to
  123.  
  124. MY SIGNATURES ARE INCLUDED AS EXAMPLES, DON'T FORGET TO CHANGE THEM BEFORE
  125. THEY GET ADDED TO YOUR MESSAGES. ;-)
  126.  
  127.  
  128.  
  129. KEYWORDS USED:
  130.  
  131.   Keyword : Name <name>
  132.   Type    : Compulsory
  133.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  134.     This should be your name, the name of the person whose messages the
  135.     signature should be added to.
  136.  
  137.   Keyword : AddText <file>
  138.   Type    : Compulsory
  139.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  140.     This is the default text file that is added to the bottom of processed
  141.     messages.
  142.  
  143.   Keyword : AreasList <file>
  144.   Type    : Compulsory
  145.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  146.     This is the list of areas to be scanned, and may also contain alternate
  147.     textfile specifications to be added to individual areas and also
  148.     alternate tagline files for individual areas.
  149.  
  150.   Keyword : QuoteFile <file>
  151.   Type    : Optional
  152.   Default : No quotes used
  153.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  154.     This is the default list of taglines used to replace %q in the default
  155.     and alternate AddText files.
  156.  
  157.   Keyword : NoLog <logging types>
  158.   Type    : Optional
  159.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  160.     This keyword is used for disabling some of the logging if you wish to
  161.     cut down the log size a bit.  You just specify the types one after the
  162.     other as they appear on the very left of the SIGADD.LOG file.
  163.  
  164.  
  165.  
  166. EXAMPLE CONFIGURATION FILES:
  167. ============================
  168.  
  169. An example of the main SIGADD.CFG configuration file follows:
  170.  
  171. ----------------------------------------------------------------- CUT HERE
  172. ; SIGaddST   Copyright (c) Paul Civati
  173. ;
  174. ; Example SIGaddST configuration file
  175. ;
  176. Name           Paul Civati
  177. AddText        d:\point\system\general.sig
  178. AreasList      d:\point\system\sigadd.lst
  179. QuoteFile      d:\point\system\taglines.txt
  180. NoLog          += -#
  181. ----------------------------------------------------------------- CUT HERE
  182.  
  183. An example areas list file follows:
  184.  
  185. ----------------------------------------------------------------- CUT HERE
  186. ; SIGaddST   Copyright (c) Paul Civati
  187. ;
  188. ; Example SIGaddST areas list file
  189. ;
  190. d:\point\system\areas\tavchat
  191. d:\point\system\areas\n_nest,d:\point\system\alt_sig1.sig,d:\alt_tags.txt
  192. d:\point\system\areas\n_st
  193. d:\point\system\areas\n_comms,d:\point\system\smaladdr.sig
  194. d:\point\system\areas\n_prog
  195. d:\point\system\areas\n_progc
  196. d:\point\system\areas\n_common,d:\cmn_sig.sig,d:\cmn_tags.txt,The_Evil_PaulC
  197. ; d:\point\system\areas\uukjobs,d:\point\system\usenet.sig,d:\moretags.txt
  198. d:\point\system\areas\ujbsoffr,d:\point\system\usenet.sig
  199. ; d:\point\system\areas\ujbsdisc,d:\point\system\usenet.sig
  200. ; d:\point\system\areas\ujbswant,d:\point\system\usenet.sig
  201. d:\point\system\areas\u_csas,d:\point\system\usenetst.sig
  202. d:\point\system\areas\u_csast,d:\point\system\usenetst.sig
  203. ----------------------------------------------------------------- CUT HERE
  204.  
  205.  
  206.  
  207. ===============================================================================
  208. PROGRAM UPDATE HISTORY:
  209. -------------------------------------------------------------------------------
  210.  
  211. 1.00<                Not released
  212. ---------------------------------
  213.  * No versions prior to 1.00 were released because they were very buggy,
  214.    ie. they didn't work without crashing. ;-(
  215.  
  216. 1.00 - Jun 23 1994  First release
  217. ---------------------------------
  218.  * Initial release, issued to a few people.
  219.  
  220. 1.01 - Jul 06 1994  Small release
  221. ---------------------------------
  222.  * Someone asked for a copy so I gave them a copy. ;-)
  223.  * Fixed bug where trailing spaces on the area paths in the areas list file
  224.    would cause a file not found error.
  225.  * Added a new configuration keyword, 'NoLog' allows you to specify logging
  226.    types that should be excluded from the SIGADD.LOG file, thanks to Steve
  227.    Basford for that suggestion, I had to add it really seeing as he sent
  228.    me a nice donation of œ5, thanks Steve. :-)
  229.  
  230. 1.02 - Jul 09 1994  Not released
  231. ---------------------------------
  232.  * Fixed NoLog bug, it would truncate after a space, a 'NoLog += -#%' for
  233.    example would not be read after the '+=' and the ' -#%' log types would
  234.    still be logged.
  235.  
  236. 1.03 - Aug 24 1994  Small release
  237. ---------------------------------
  238.  * Added new feature, extra option added to areas list file, you can now
  239.    change your 'from name' on msgs that your sig is added to, this is just
  240.    done as an extra parameter in the areas list, reread the areas list
  241.    section for further explanation.
  242.  
  243.  
  244. ===============================================================================
  245.  
  246. Mail to me at the below address if there are any problems...
  247.  
  248. Due to lack of money, being 19 and at college I don't currently run a BBS of
  249. my own (would like to!) but can be contacted at one of the below addresses,
  250. although I prefere internet email or netmail to one of my point addresses:
  251.  
  252. Paul S Civati               @ The Tavern BBS
  253. 36 Sunnymede Avenue,          FidoNet 2:254/108
  254. Carshalton,                   AtariNet 51:502/100
  255. Surrey,                       NeST 90:102/140
  256. SM5 4JF,                      TurboNet 100:1011/0
  257. England.                      UK +44-181-445-6514 24 Hours
  258.  
  259. Paul Civati @ FidoNet 2:254/108.1, AtariNet 51:502/102, NeST 90:102/142
  260.               TurboNet 100:1011/0.1, InterNet: paul.civati@mettav.exnet.com
  261.  
  262. ===============================================================================
  263.  
  264.